/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.wsinfra.deployment;

import javax.servlet.ServletConfig;
import javax.xml.soap.SOAPMessage;

import cgl.narada.wsinfra.deployment.impl.SOAPServletContainerImpl;
import cgl.narada.wsinfra.exception.DeploymentException;

/** This container will be used to register SOAP Based roles. It is expected 
    that in some cases there may be a servlet associated per role. Typically,
    this need not be the case. Upon the receipt of a SOAP message, a special
    class will parse the SOAP message to determine all the <i>targeted</i>
    roles. Depending on the roles, appropriate filter pipelines will be 
    deployed to ensure complete processing of a SOAP message. In some cases,
    a set of default roles may be associated with a given SOAP message. This
    may include processing related to logging every SOAP message etc.

    @author Shrideep Pallickara
    $Date: 2005/07/29 22:44:01 $
    $Revision: 1.1 $
 */ 

public abstract class SOAPServletContainer {

  private static final SOAPServletContainer instance = 
  SOAPServletContainerImpl.getInstance();


  public static SOAPServletContainer getInstance() {
    return instance;
  }

  /** Starts up the HTTP Servlet container at this port number. This method
   throws an exception */
  public abstract void initializeServices(int portNum) 
    throws DeploymentException;


  /** Start Services */
  public abstract void startServices() throws DeploymentException;

  /** Stop Services */
  public abstract void stopServices() throws DeploymentException;


  /** This method registers a servlet. The servlet is not associated with
      a specific role.*/
  public abstract void 
  registerServlet(String servletName, String servletPath, String servletClass)
    throws DeploymentException ;


  /** This method deregisters a servlet. The servlet is not associated with
      a specific role.*/
  public abstract void deregisterServlet(String servletName) 
    throws DeploymentException;


  /** This method registers a servlet associated with a specific role. This 
      method throws an exception if another servlet has been previously 
      registered for this role or if there are problems deploying this 
      servlet.*/
  public abstract void 
  registerServletForRole(String role, String servletName, 
			 String pathSpec, String servletClass)
    throws DeploymentException;
  
  
  /** This method de-registers a servlet associated witha a specific role. This
      method throws an exception if there are no servlets registered for this
      role. */
  public abstract void 
  deregisterServletForRole(String servletName, String role) 
    throws DeploymentException;


  /** Checks to see if a servlet has been registered for the specified role. */
  public abstract boolean 
  isServletRegisteredForRole(String servletName, String role)
    throws DeploymentException;


  /** Retrieve the ServletContext associated with a specific role. */
  public abstract ServletConfig getServletConfigForRole(String role)
    throws DeploymentException;


  /** Method used by servlets to notify about SOAP messages received over the
      network. */
  public abstract void 
  processSOAPMessage(SOAPMessage soapMessage,
		     String servletName) throws DeploymentException;

}
